<html lang="en-US">

<head>
    
<title>Go：我有注解，Java：不，你没有！ - 花落雨忧</title>

<meta property="og:title" content="Go：我有注解，Java：不，你没有！ - 花落雨忧">



    



    
    <meta property="description" content="大家好，我是煎鱼。
作为一位 Go 程序员，你会发现身边的同事大多都拥有其他语言的编写经验。那势必就会遇到一点，要把新学到的知识和以前的知识建立连接。
特殊在于，Go 有些特性是其他语言有，他没有的。最经典的就是 N 位 Java 同学寻找 Go 语言的注解在哪里，总要解释。
为此，今天煎鱼就带大家了解一下 Go 语言的注解的使用和情况。
[&amp;hellip;] 注解（Annotation）最早出现 &amp;hellip;">
    <meta property="og:description" content="大家好，我是煎鱼。
作为一位 Go 程序员，你会发现身边的同事大多都拥有其他语言的编写经验。那势必就会遇到一点，要把新学到的知识和以前的知识建立连接。
特殊在于，Go 有些特性是其他语言有，他没有的。最经典的就是 N 位 Java 同学寻找 Go 语言的注解在哪里，总要解释。
为此，今天煎鱼就带大家了解一下 Go 语言的注解的使用和情况。
[&amp;hellip;] 注解（Annotation）最早出现 &amp;hellip;">
    






<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1">

<link rel="shortcut icon" href="https://www.lican.site/logo/logo.png" type="image/x-icon" />



<link rel="stylesheet" href="/css/style.min.css" />

<link rel="stylesheet" href="/css/reset.min.css" />




<script src="https://www.lican.site/js/highlight.min.js"></script>

<script>
hljs.configure({ ignoreUnescapedHTML: true })
hljs.highlightAll();
</script>


<script src="https://www.lican.site/js/jquery.min.js"></script>




<link href="https://www.lican.site/css/hugo-code.min.css" rel="stylesheet" />



    <style>
        .post-content img {
            max-width: 400px;
        }
    </style>
</head>

<body id="period" class="home blog">
    <a class="skip-content" href="#main">Press "Enter" to skip to content</a>
    <div id="overflow-container" class="overflow-container">
        <header class="site-header" id="site-header" role="banner">
    <div class="max-width">
        <div id="title-container" class="title-container">
            <div id="site-title" class="site-title"><a href="/">花落雨忧</a></div>
            <p class="tagline">思所及 力所行 方为真.</p>
        </div>
        
        <div id="menu-primary-container" class="menu-primary-container">
            <div class="icon-container">
            </div>
            <div id="menu-primary" class="menu-container menu-primary" role="navigation">
                <nav class="menu">
                    <ul id="menu-primary-items" class="menu-primary-items">
                        
                        
                        <li id="menu-item-0"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/posts" aria-current="page" tabindex="0">首页</a></li>
                        
                        <li id="menu-item-1"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/tech/" aria-current="page" tabindex="1">技术文档</a></li>
                        
                        <li id="menu-item-2"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/article/" aria-current="page" tabindex="2">文章</a></li>
                        
                        <li id="menu-item-3"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/project/" aria-current="page" tabindex="3">项目</a></li>
                        
                        <li id="menu-item-4"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/about/" aria-current="page" tabindex="4">关于</a></li>
                        
                    </ul>
                </nav>
            </div>
        </div>
    </div>
</header>
        <div id="primary-container" class="primary-container">
            <div class="max-width">
                <section id="main" class="main" role="main">
                    <div id="loop-container" class="loop-container">
                        <div
                            class="post type-post status-publish format-standard hentry entry">
                            <article>
                                <div class="post-container">
                                    <div class="post-header">
                                        <h2 class="post-title">
                                            <a href="/posts/go/annotation/">Go：我有注解，Java：不，你没有！</a>
                                        </h2>
                                        
                                        <div class="post-byline">Published on
                                            <a class="date" href="javascript:;">2021/12/31</a>
                                            
                                            
                                            
                                            
                                            
                                        
                                    </div>
                                    <div class="post-content">
                                        <p>大家好，我是煎鱼。</p>
<p>作为一位 Go 程序员，你会发现身边的同事大多都拥有其他语言的编写经验。那势必就会遇到一点，要把新学到的知识和以前的知识建立连接。</p>
<p><img src="https://files.mdnice.com/user/3610/050a9802-1ca2-4634-859d-325a09d418c5.png" alt="图来自网络"></p>
<p>特殊在于，Go 有些特性是其他语言有，他没有的。最经典的就是 N 位 Java 同学寻找 Go 语言的注解在哪里，总要解释。</p>
<p>为此，今天煎鱼就带大家了解一下 Go 语言的注解的使用和情况。</p>
<h2 id="什么是注解">什么是注解</h2>
<h3 id="了解历史">了解历史</h3>
<p>注解（Annotation）最早出现自何处，翻了一圈并没有找到。但可以明确，在注解的使用中，Java 注解最为经典，为了便于理解，因此我们基于 Java 做初步的注解理解。</p>
<p><img src="https://files.mdnice.com/user/3610/3c9e2434-c5f4-4d7a-bd2d-a8b582b570c8.png" alt=""></p>
<p>在 2002 年，JSR-175 提出了 《<a href="https://jcp.org/en/jsr/detail?id=175">A Metadata Facility for the Java Programming Language</a>》，也就是为 Java 编程语言提供元数据工具。</p>
<p>这就是现在使用最广泛地注解（Annotation）的来源。
示例如下：</p>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-golang" data-lang="golang"><span style="color:#75715e">// @annotation1
</span><span style="color:#75715e">// @annotation2
</span><span style="color:#75715e"></span><span style="color:#66d9ef">func</span> <span style="color:#a6e22e">Hello</span>() <span style="color:#66d9ef">string</span> {
        <span style="color:#66d9ef">return</span> <span style="color:#e6db74">&#34;&#34;</span>
}
</code></pre></div><p>在格式上均以 “@” 作为注解标识来使用。</p>
<h3 id="注解例子">注解例子</h3>
<p>摘抄自 @wikipedia 的一个注解例子：</p>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-java" data-lang="java">  <span style="color:#75715e">//等同于 @Edible(value = true)
</span><span style="color:#75715e"></span>  <span style="color:#a6e22e">@Edible</span><span style="color:#f92672">(</span><span style="color:#66d9ef">true</span><span style="color:#f92672">)</span>
  Item item <span style="color:#f92672">=</span> <span style="color:#66d9ef">new</span> Carrot<span style="color:#f92672">();</span>

  <span style="color:#66d9ef">public</span> <span style="color:#a6e22e">@interface</span> Edible <span style="color:#f92672">{</span>
    <span style="color:#66d9ef">boolean</span> <span style="color:#a6e22e">value</span><span style="color:#f92672">()</span> <span style="color:#66d9ef">default</span> <span style="color:#66d9ef">false</span><span style="color:#f92672">;</span>
  <span style="color:#f92672">}</span>

  <span style="color:#a6e22e">@Author</span><span style="color:#f92672">(</span>first <span style="color:#f92672">=</span> <span style="color:#e6db74">&#34;Oompah&#34;</span><span style="color:#f92672">,</span> last <span style="color:#f92672">=</span> <span style="color:#e6db74">&#34;Loompah&#34;</span><span style="color:#f92672">)</span>
  Book book <span style="color:#f92672">=</span> <span style="color:#66d9ef">new</span> Book<span style="color:#f92672">();</span>

  <span style="color:#66d9ef">public</span> <span style="color:#a6e22e">@interface</span> Author <span style="color:#f92672">{</span>
    String <span style="color:#a6e22e">first</span><span style="color:#f92672">();</span>
    String <span style="color:#a6e22e">last</span><span style="color:#f92672">();</span>
  <span style="color:#f92672">}</span>
  
  <span style="color:#75715e">// 该标注可以在运行时通过反射访问。
</span><span style="color:#75715e"></span>  <span style="color:#a6e22e">@Retention</span><span style="color:#f92672">(</span>RetentionPolicy<span style="color:#f92672">.</span><span style="color:#a6e22e">RUNTIME</span><span style="color:#f92672">)</span> 
  <span style="color:#75715e">// 该标注只用于类内方法。
</span><span style="color:#75715e"></span>  <span style="color:#a6e22e">@Target</span><span style="color:#f92672">({</span>ElementType<span style="color:#f92672">.</span><span style="color:#a6e22e">METHOD</span><span style="color:#f92672">})</span>
  <span style="color:#66d9ef">public</span> <span style="color:#a6e22e">@interface</span> Tweezable <span style="color:#f92672">{</span>
  <span style="color:#f92672">}</span>

</code></pre></div><p>在上述例子中，通过注解去做了一系列的定义、声明、赋值等。若是对语言既有注解不熟，或是做的比较复杂的注解，就会有一定的理解成本。</p>
<p>在业内也常常会说，<strong>注解就是 “在源码上进行编码”</strong>，注解的存在，有着明确的优缺点。你觉得呢？</p>
<h2 id="注解的作用">注解的作用</h2>
<p>在注解的的作用上，分为如下几点：</p>
<ol>
<li>为编译器提供信息：注释可以被编译器用来检测错误或支持警告。</li>
<li>编译时和部署时处理：软件工具可以处理注释信息以生成代码、XML文件等。</li>
<li>运行时处理：有些注解可以在运行时检查，并用于其他用途。</li>
</ol>
<h2 id="go-注解在哪里">Go 注解在哪里</h2>
<h3 id="现状">现状</h3>
<p>Go 语言本身并没有原生支持强大的注解，仅限于以下两种：</p>
<ul>
<li>编译时生成：go:generate</li>
<li>编译时约束：go:build</li>
</ul>
<p>但这先按不足以作为一个函数注解来使用，也无法形成像 Python 那样的装饰器行为。</p>
<h3 id="为什么不支持">为什么不支持</h3>
<p>Go issues 上有人提过类似的提案：</p>
<p><img src="https://files.mdnice.com/user/3610/9695f163-65e8-456a-8dce-bb8551739016.png" alt=""></p>
<p>Go Contributor @ianlancetaylor 给出了明确的答复，Go在设计上更倾向于明确的、显式的编程风格。</p>
<p>思考的优缺点如下：</p>
<ul>
<li>优势：不知道 Go 能从添加装饰器中得到什么好处，没能在 issues 上明确论证。</li>
<li>缺点：是明确的，会存在意外设置的情况。</li>
</ul>
<p>因如下原因，没有接受注解：</p>
<ul>
<li>对比现有代码方法，这种装饰器的新的方法没有提供比现有方法更多的优势，大到足矣推翻原有的设计思路。</li>
<li>社区内的投票，支持的也很少（基于表情符号的投票），用户反馈不多。</li>
</ul>
<p>可能有小伙伴会说了，有注解做装饰器了，代码会简洁不少。</p>
<p>对此 Go 团队的态度很明确：</p>
<p><img src="https://files.mdnice.com/user/3610/bb357e12-9b15-4729-9381-977d164b6b04.png" alt=""></p>
<p>Go 认为<strong>可读性更重要</strong>，如果只是额外多写一点代码，在权衡后，还是可以接受的。</p>
<h2 id="用-go-实现注解">用 Go 实现注解</h2>
<p>虽然 Go 语言官方没有原生的完整支持，但开源社区中也有小伙伴已经放出了大招，借助各项周边工具和库来实现特定的函数注解功能。</p>
<p>GitHub 项目分别如下：</p>
<ul>
<li><a href="github.com/MarcGrol/golangAnnotations">MarcGrol/golangAnnotations</a></li>
<li><a href="https://github.com/u2takey/go-annotation">u2takey/go-annotation</a></li>
</ul>
<p>使用示例如下：</p>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-golang" data-lang="golang"><span style="color:#f92672">package</span> <span style="color:#a6e22e">tourdefrance</span>

<span style="color:#75715e">//go:generate golangAnnotations -input-dir .
</span><span style="color:#75715e"></span>
<span style="color:#75715e">// @RestService( path = &#34;/api/tour&#34; )
</span><span style="color:#75715e"></span><span style="color:#66d9ef">type</span> <span style="color:#a6e22e">TourService</span> <span style="color:#66d9ef">struct</span>{}

<span style="color:#66d9ef">type</span> <span style="color:#a6e22e">EtappeResult</span> <span style="color:#66d9ef">struct</span>{ <span style="color:#f92672">...</span> }

<span style="color:#75715e">// @RestOperation( method = &#34;PUT&#34;, path = &#34;/{year}/etappe/{etappeUid}&#34; )
</span><span style="color:#75715e"></span><span style="color:#66d9ef">func</span> (<span style="color:#a6e22e">ts</span> <span style="color:#f92672">*</span><span style="color:#a6e22e">TourService</span>) <span style="color:#a6e22e">addEtappeResults</span>(<span style="color:#a6e22e">c</span> <span style="color:#a6e22e">context</span>.<span style="color:#a6e22e">Context</span>, <span style="color:#a6e22e">year</span> <span style="color:#66d9ef">int</span>, <span style="color:#a6e22e">etappeUid</span> <span style="color:#66d9ef">string</span>, <span style="color:#a6e22e">results</span> <span style="color:#a6e22e">EtappeResult</span>) <span style="color:#66d9ef">error</span> {
	<span style="color:#66d9ef">return</span> <span style="color:#66d9ef">nil</span>
}
</code></pre></div><p>对 Go 注解的使用感兴趣的小伙伴可以自行查阅使用手册。</p>
<p>我们更多的关心，Go 原生都没支持，那么开源库都是如何实现的呢？在此我们借助 <a href="github.com/MarcGrol/golangAnnotations">MarcGrol/golangAnnotations</a> 项目所提供的思路来讲解。</p>
<p>分为三个步骤：</p>
<ol>
<li>解析代码。</li>
<li>模板处理。</li>
<li>生成代码。</li>
</ol>
<h3 id="解析-ast">解析 AST</h3>
<p>首先，我们需要用用 go/ast 标准库获取代码所生成的 AST Tree 中需要的内容和结构。</p>
<p>示例代码如下：</p>
<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-shell" data-lang="shell">parsedSources :<span style="color:#f92672">=</span> ParsedSources<span style="color:#f92672">{</span>
    PackageName: <span style="color:#e6db74">&#34;tourdefrance&#34;</span>,
    Structs:     <span style="color:#f92672">[]</span>model.Struct<span style="color:#f92672">{</span>
        <span style="color:#f92672">{</span>
      	     DocLines:   <span style="color:#f92672">[]</span>string<span style="color:#f92672">{</span><span style="color:#e6db74">&#34;// @RestService( path = &#34;</span>/api/tour<span style="color:#e6db74">&#34; )&#34;</span><span style="color:#f92672">}</span>,
      	     Name:       <span style="color:#e6db74">&#34;TourService&#34;</span>,
      	     Operations: <span style="color:#f92672">[]</span>model.Operation<span style="color:#f92672">{</span>
                <span style="color:#f92672">{</span>
              	    DocLines:   <span style="color:#f92672">[]</span>string<span style="color:#f92672">{</span><span style="color:#e6db74">&#34;// @RestOperation( method = &#34;</span>PUT<span style="color:#e6db74">&#34;, path = &#34;</span>/<span style="color:#f92672">{</span>year<span style="color:#f92672">}</span>/etappe/<span style="color:#f92672">{</span>etappeUid<span style="color:#f92672">}</span><span style="color:#e6db74">&#34;},
</span><span style="color:#e6db74">              	    ...
</span><span style="color:#e6db74">                },
</span><span style="color:#e6db74">            },
</span><span style="color:#e6db74">        },
</span><span style="color:#e6db74">    },
</span><span style="color:#e6db74">}
</span></code></pre></div><p>我们可以看到，在 AST Tree 中能够获取到在示例代码中所定义的注解内容，我们就可以依据此去做很多奇奇怪怪的事情了。</p>
<h3 id="模板生成">模板生成</h3>
<p>紧接着，在知道了注解的输入是什么后，我们只需要根据实际情况，编写对应的模板生成器 code-generator 就可以了。</p>
<p>我们会基于 text/template 标准库来实现，比较经典的像是 <a href="https://github.com/kubernetes/code-generator">kubernetes/code-generator</a> 是一个可以参考的实现。</p>
<p>代码实现完毕后，将其编译成 go plugin，便于我们在下一步调用就可以了。</p>
<h3 id="代码生成">代码生成</h3>
<p>最后，万事俱备只欠东风。差的就是告诉工具，哪些 Go 文件中包含注解，需要我们去生成的。</p>
<p>这时候我们可以使用 <code>//go:generate</code> 在 Go 文件声明。就像前面的项目中所说的：</p>
<pre><code>//go:generate golangAnnotations -input-dir .
</code></pre><p>声明该 Go 文件需要生成，并调用前面编写好的 golangAnnotations 二进制文件，就可以实现基本的 Go 注解生成了。</p>
<h2 id="总结">总结</h2>
<p>今天在这篇文章中，我们介绍了注解（Annotation）的历史背景。同时我们针对 Go 语言目前原生的注解支持情况进行了说明。</p>
<p>也面向为什么 Go 没有像 Java 那样支持强大的注解进行了基于 Go 官方团队的原因解释。如果希望在 Go 实现注解的，也提供了相应的开源技术方案。</p>
<p><strong>你觉得 Go 语言是否需要强大的注解支持</strong>呢，欢迎你在评论区留言和讨论！</p>


                                        
                                        
                                        
                                        <div class="rp4wp-related-posts">
                                            <h3>相关文章</h3>
                                            <ul>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/ternary-operator/">Go 凭什么不支持三元运算符？</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/type-after/">为什么 Go 语言把类型放在后面？</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/slice-leak/">Go 切片导致内存泄露，被坑两次了！</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/when-gc/">Go 什么时候会触发 GC？</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/map-reset/">Go map 如何缩容？</a>
                                                    </div>
                                                </li>
                                                
                                            </ul>
                                        </div>
                                        
                                        
                                    </div>

                                    
                                    
                                    

                                    
                                    <div class="post-meta">
                                        
                                        
                                        <div class="post-tags">
                                            <ul>
                                            
                                            <li>
                                                <a href="/tags/go" title="View all posts tagged match">go</a>
                                            </li>
                                            
                                            <li>
                                                <a href="/tags/%e4%b8%ba%e4%bb%80%e4%b9%88" title="View all posts tagged match">为什么</a>
                                            </li>
                                            
                                            </ul>
                                        </div>
                                        
                                        
                                        <nav class="further-reading">
                                            
                                            <div class="previous">
                                                <span>&lt;&lt; Prev</span>
                                                <a href="https://www.lican.site/posts/go/type-after/"
                                                    rel="prev">为什么 Go 语言把类型放在后面？</a> </div>
                                            
                                            
                                            <div class="next">
                                                <span>Next >></span>
                                                <a href="https://www.lican.site/posts/go/go-golang/">Go 和 Golang 有什么关系？</a> 
                                            </div>
                                            
                                        </nav>
                                    </div>
                                    
                                    

                                    
                                    
                                    

                                </div>
                            </article>
                        </div>
                    </div>
                </section>
                <aside class="sidebar sidebar-primary" id="sidebar-primary" role="complementary">
    <h1 class="screen-reader-text">Sidebar</h1>
    

    
    
    <section id="text-2" class="widget widget_text">
        <div class="textwidget">
            
            <div id="profile">
                <div id="profile_picture"><img src="https://www.lican.site/logo/logo.png"></div>
                <div id="profile_intro">
                    <p><span class="name">Lican</span></p>
                    <p class="intro">全栈开发者，爱好造轮子。</p>
                </div>
            </div>
            
            <p>
                <script type="text/javascript">
                    (function ($) {
                        $(document).ready(function () {
                            var menuPrimaryContainer = $('#menu-primary-container');
                            var profile = $('#text-2');
                            $('#toggle-navigation').click(function () {
                                if (menuPrimaryContainer.hasClass('open')) {
                                    profile.removeClass('open');
                                } else {
                                    profile.addClass('open');
                                }
                            });
                        });
                    })(jQuery);
                </script>
            </p>
        </div>
    </section>
    
    
    
    
    
    <section id="text-5" class="widget widget_text">
        <h2 class="widget-title">开源项目</h2>
        <div class="textwidget">
            <div id="projects" style="line-height: 22px;">
                
                <a href="https://github.com/idoubi/gonews"
                    target="_blank">gonews</a>: &nbsp;Daily news for golang<br>
                
                <a href="https://github.com/idoubi/sql2struct"
                    target="_blank">sql2struct</a>: &nbsp;Generate go struct according to SQL<br>
                
                <a href="https://github.com/idoubi/goz"
                    target="_blank">goz</a>: &nbsp;Request library used in golang<br>
                
        </div>
    </section>
    
    

    
    
    
    
    

    
    
    

    
    
    

    
    
    
    
</aside>
            </div>
        </div>

        <footer id="site-footer" class="site-footer" role="contentinfo">
    <div class="max-width">
    </div>
    <div class="footer">
        <div id="footercontent">
            © lican.vip All rights reserved<br/>
            Built with Hugo Theme <a href="https://github.com/idoubi/hugo-theme-period" target="_blank">Period</a>
        </div>
    </div>
</footer>

<script>
    var _hmt = _hmt || [];
    (function() {
      var hm = document.createElement("script");
      hm.src = "https://hm.baidu.com/hm.js?e8351b6d4626d5881d439ea1f6184baa";
      var s = document.getElementsByTagName("script")[0]; 
      s.parentNode.insertBefore(hm, s);
    })();
</script>
    
    
    </div>
    
</body>

</html>